:book: docs: Drastically simplified the Argo CD agent add-on solution guide by mikeshng · Pull Request #1230 · open-cluster-management-io/ocm

mikeshng · 2025-10-28T23:02:27Z

Summary

docs: Drastically simplified the Argo CD agent add-on solution guide)by using the OCM Helm repo and chart deployment method

Related issue(s)

Fixes #NA

Summary by CodeRabbit

Documentation
- Updated Argo CD integration documentation with new terminology: Advanced Pull Model and Push Model.
- Revised deployment instructions and Helm chart references.
- Added Quick Start section for faster onboarding.
- Updated application manifest examples with revised server URL format specifications.

…by using the OCM Helm repo and chart deployment method Signed-off-by: Mike Ng <ming@redhat.com>

openshift-ci · 2025-10-28T23:02:35Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: mikeshng

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details

Needs approval from an approver in each of these files:

~~solutions/OWNERS~~ [mikeshng]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

mikeshng · 2025-10-28T23:02:46Z

/assign @haoqing0110

coderabbitai · 2025-10-28T23:02:49Z

Walkthrough

Documentation updates across three Argo CD and OCM integration solutions. Key changes include renaming deployment models (Add-on to agent-oriented and Pull models), updating Helm chart references and deployment commands, revising application manifest examples with new server URL formats, removing extensive setup steps and cryptographic key guidance, and restructuring README sections to emphasize pull-based architecture.

Changes

Cohort / File(s)	Summary
Argo CD Agent Documentation Restructuring `solutions/argocd-agent/README.md`	Title and overview rewritten to reflect Advanced Pull Model; deployment guidance updated to use new Helm chart repository and commands; application manifest examples revised with placeholder server URLs and agent name query parameters; extensive setup steps, cryptographic key guidance, and Autonomous mode sections removed; terminology shifted from AddOn to agent-oriented language.
Basic Pull Model Introduction `solutions/deploy-argocd-apps-pull/README.md`	Model renamed from "Add-on" to "Basic Pull Model"; new Quick Start section added with link to Getting Started; new section header added referencing OCM Argo CD Advanced Pull Model; overview content rewritten to emphasize pull-based delivery; push vs. pull model comparisons and illustrations added.
Push Model Title Clarification `solutions/deploy-argocd-apps/README.md`	README title updated from "Deploy applications with Argo CD" to "Deploy applications with Argo CD Push Model".

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

The argocd-agent/README.md file contains substantial structural rewrites, significant content removal, and updated deployment examples that require careful verification of accuracy against actual Helm chart changes.
Verify that terminology shifts (AddOn → agent, push → Advanced Pull Model, etc.) are consistently applied across documentation.
Confirm that updated Helm install commands and server URL format examples match current implementation requirements.

Possibly related PRs

📖 docs: update argocd-agent solution with new param #1087: Modifies the same solutions/argocd-agent/README.md Helm installation documentation with additions for Redis and principal configuration parameters.
📖 Revert "docs: update argocd-agent solution with new param" #1128: Updates the same file with simplified Helm install snippet and minimal addon configuration details.

Suggested labels

lgtm

Suggested reviewers

qiujian16
jnpacker

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.	You can run `@coderabbitai generate docstrings` to improve docstring coverage.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Title Check	✅ Passed	The PR title ":book: docs: Drastically simplified the Argo CD agent add-on solution guide" clearly and accurately describes the main changes in the changeset. The raw summary shows substantial documentation updates across three README files, with content being trimmed, simplified, and refactored to use Helm chart deployment methods. The emoji is appropriately used to indicate documentation changes, and the phrasing is concise and specific without being overly vague or generic.
Description Check	✅ Passed	The PR description follows the required template structure with both the Summary and Related issue(s) sections present. The Summary section provides meaningful context, explaining that the guide was simplified by using the OCM Helm repository and chart deployment method, which aligns with the changes shown in the raw summary. The Related issue(s) section is included, though it indicates "Fixes #NA" suggesting no specific linked issue. The description is mostly complete and contains the required template elements, though there is a minor typo ("guide)by" instead of "guide by").

✨ Finishing touches

🧪 Generate unit tests (beta)

Create PR with unit tests
Post copyable unit tests in a comment

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 8d46ca1 and 25bcf34.

📒 Files selected for processing (3)

solutions/argocd-agent/README.md (4 hunks)
solutions/deploy-argocd-apps-pull/README.md (2 hunks)
solutions/deploy-argocd-apps/README.md (1 hunks)

🧰 Additional context used

🪛 LanguageTool

solutions/deploy-argocd-apps-pull/README.md

[grammar] ~6-~6: Use a hyphen to join words.
Context: ...e hub cluster down to the registered OCM managed clusters. To try it out, check o...

(QB_NEW_EN_HYPHEN)

🔇 Additional comments (4)

solutions/argocd-agent/README.md (2)

88-92: Excellent simplification with Helm-based deployment.

The new deployment approach using the OCM Helm chart repository (helm install argocd-agent-addon ocm/argocd-agent-addon) is a major improvement over previous manual setup steps. This directly aligns with the PR objective to simplify the guide. The commands are clear and straightforward, making it more accessible for new users.

141-141: Updated server URL format with agentName parameter is well-documented.

The server URL format including the agentName query parameter correctly reflects the agent-based architecture. The example provides clear guidance for users, and the documentation change supports the shift to the Advanced Pull Model.

solutions/deploy-argocd-apps-pull/README.md (2)

9-11: Quick Start section improves documentation navigation.

Adding the Quick Start section with a link to getting-started.md provides clear entry point for new users. This complements the Overview section well and follows documentation best practices.

35-38: External reference to advanced pull model is well-placed.

The reference to the argocd-pull-integration repository provides users with a clear path to advanced documentation, complementing the Basic Pull Model guide. This is consistent across the PR and helps users understand the relationship between the basic and advanced models.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

haoqing0110 · 2025-10-29T03:25:11Z

The titles of the three documents are very clear, just a bit confused by the file path argocd-agent deploy-argocd-apps-pull and deploy-argocd-apps. Not sure if anywhere else referencing to this and is it easy to unify the folder name?

mikeshng · 2025-10-29T13:15:58Z

Not sure if anywhere else referencing to this and is it easy to unify the folder name?

Good catch. They are being referred in other places so we have to stick with these names for now.
I will fix them up when I make further changes to clusteradm and website.

fxiang1 · 2025-10-29T13:16:35Z

/lgtm

docs: Drastically simplified the Argo CD agent add-on solution guide …

25bcf34

…by using the OCM Helm repo and chart deployment method Signed-off-by: Mike Ng <ming@redhat.com>

openshift-ci bot requested review from deads2k and qiujian16 October 28, 2025 23:02

openshift-ci bot added the approved label Oct 28, 2025

openshift-ci bot assigned haoqing0110 Oct 28, 2025

openshift-ci bot assigned fxiang1 Oct 29, 2025

openshift-ci bot added the lgtm label Oct 29, 2025

openshift-merge-bot bot merged commit b5c6587 into open-cluster-management-io:main Oct 29, 2025
17 checks passed

mikeshng deleted the update-argocd-solutions branch October 29, 2025 16:49

coderabbitai bot mentioned this pull request Oct 30, 2025

📖 docs: fix argocd-agent docs #1231

Merged

coderabbitai bot mentioned this pull request Nov 15, 2025

📖 docs: fix argocd-agent helm install instruction #1259

Merged

coderabbitai bot mentioned this pull request Jan 25, 2026

📖 docs: Update argocd-agent solution to use clusteradm #1348

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

📖 docs: Drastically simplified the Argo CD agent add-on solution guide#1230

📖 docs: Drastically simplified the Argo CD agent add-on solution guide#1230
openshift-merge-bot[bot] merged 1 commit intoopen-cluster-management-io:mainfrom
mikeshng:update-argocd-solutions

mikeshng commented Oct 28, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

openshift-ci bot commented Oct 28, 2025

Uh oh!

mikeshng commented Oct 28, 2025

Uh oh!

coderabbitai bot commented Oct 28, 2025 •

edited

Loading

Uh oh!

haoqing0110 commented Oct 29, 2025

Uh oh!

mikeshng commented Oct 29, 2025

Uh oh!

fxiang1 commented Oct 29, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

mikeshng commented Oct 28, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Related issue(s)

Summary by CodeRabbit

Uh oh!

openshift-ci bot commented Oct 28, 2025

Uh oh!

mikeshng commented Oct 28, 2025

Uh oh!

coderabbitai bot commented Oct 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Possibly related PRs

Suggested labels

Suggested reviewers

Pre-merge checks and finishing touches

Uh oh!

haoqing0110 commented Oct 29, 2025

Uh oh!

mikeshng commented Oct 29, 2025

Uh oh!

fxiang1 commented Oct 29, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

mikeshng commented Oct 28, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Oct 28, 2025 •

edited

Loading